/*
 *  Copyright 2007-2008 by Matthias Buch-Kromann <mbk.isv@cbs.dk>.
 *  *
 *  This file is part of the Open-source Dependency Toolkit (OSDT),
 *  see http://code.google.com/p/open-source-dependency-toolkit.
 *  
 *  The OSDT is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as 
 *  published by the Free Software Foundation, either version 3 of 
 *  the License, or (at your option) any later version.
 * 
 *  The OSDT is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 * 
 *  You should have received a copy of the GNU Lesser General Public 
 *  License along with the OSDT in the files COPYING and COPYING.LESSER.
 *  If not, see http://www.gnu.org/licenses.
 */

package org.osdtsystem.graphs;

import java.util.List;
import org.osdtsystem.functions.LocalFunction;
import org.osdtsystem.graphs.views.ViewID;
import org.osdtsystem.values.EdgeID;
import org.osdtsystem.values.Feature;
import org.osdtsystem.values.Layer;
import org.osdtsystem.values.Location;
import org.osdtsystem.values.NodeID;

/**
 *
 * @author Matthias Buch-Kromann <mbk.isv@cbs.dk>
 */
public interface GraphAccessor {
    // Static graph access
    public Layer layer(LocalFunction<?,?> caller, Location loc);
    public List<EdgeID> inEdges(LocalFunction<?,?> caller, NodeID node, Layer layer);
    public List<EdgeID> outEdges(LocalFunction<?,?> caller, NodeID node, Layer layer);
    public NodeID inNode(LocalFunction<?,?> caller, EdgeID edge);
    public NodeID outNode(LocalFunction<?,?> caller, EdgeID edge);
    public Object featureValue(LocalFunction<?,?> caller, 
        Location location, Feature feature);

    // Static graph access: retrieving layers, functions, and views by name
    public Layer namedLayer(LocalFunction<?,?> caller, String uniqueName);
    public ViewID namedView(LocalFunction<?,?> caller, String uniqueName);
    
    // Dynamic graph access: functions (recursion with potential cycles)
    public Object functionValue(LocalFunction<?,?> caller,
             Location loc, String function);
}
